- 
                Notifications
    You must be signed in to change notification settings 
- Fork 159
Hide parameter and return value documentation from properties. #968
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
          
     Merged
      
      
            d-ronnqvist
  merged 4 commits into
  swiftlang:main
from
d-ronnqvist:no-parameters-for-properties
  
      
      
   
  Jul 9, 2024 
      
    
                
     Merged
            
            Hide parameter and return value documentation from properties. #968
                    d-ronnqvist
  merged 4 commits into
  swiftlang:main
from
d-ronnqvist:no-parameters-for-properties
  
      
      
   
  Jul 9, 2024 
              
            Conversation
  
    
      This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
      Learn more about bidirectional Unicode characters
    
  
  
    
    rdar://130750134
| @swift-ci please test | 
              
                    PortalPete
  
              
              reviewed
              
                  
                    Jul 3, 2024 
                  
              
              
            
            
              
                    anferbui
  
              
              approved these changes
              
                  
                    Jul 9, 2024 
                  
              
              
            
            
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Left some small comments, feel free to address them if you think they're relevant, otherwise I'm happy with this being merged.
Co-authored-by: Pete Lawrence <[email protected]> Co-authored-by: Andrea Fernandez Buitrago <[email protected]>
| @swift-ci please test | 
    
  d-ronnqvist 
      added a commit
        to d-ronnqvist/swift-docc
      that referenced
      this pull request
    
      Jul 9, 2024 
    
    
      
  
    
      
    
  
…lang#968) * Hide parameter and return value documentation from properties rdar://130750134 * Apply suggestions from code review Co-authored-by: Pete Lawrence <[email protected]> Co-authored-by: Andrea Fernandez Buitrago <[email protected]> * Fix misaligned guard conditions --------- Co-authored-by: Pete Lawrence <[email protected]> Co-authored-by: Andrea Fernandez Buitrago <[email protected]>
    
  d-ronnqvist 
      added a commit
      that referenced
      this pull request
    
      Jul 10, 2024 
    
    
      
  
    
      
    
  
…#978) * Hide parameter and return value documentation from properties rdar://130750134 * Apply suggestions from code review Co-authored-by: Pete Lawrence <[email protected]> Co-authored-by: Andrea Fernandez Buitrago <[email protected]> * Fix misaligned guard conditions
  
    Sign up for free
    to join this conversation on GitHub.
    Already have an account?
    Sign in to comment
  
      
  Add this suggestion to a batch that can be applied as a single commit.
  This suggestion is invalid because no changes were made to the code.
  Suggestions cannot be applied while the pull request is closed.
  Suggestions cannot be applied while viewing a subset of changes.
  Only one suggestion per line can be applied in a batch.
  Add this suggestion to a batch that can be applied as a single commit.
  Applying suggestions on deleted lines is not supported.
  You must change the existing code in this line in order to create a valid suggestion.
  Outdated suggestions cannot be applied.
  This suggestion has been applied or marked resolved.
  Suggestions cannot be applied from pending reviews.
  Suggestions cannot be applied on multi-line comments.
  Suggestions cannot be applied while the pull request is queued to merge.
  Suggestion cannot be applied right now. Please check back later.
  
    
  
    
Bug/issue #, if applicable: rdar://130750134
Summary
This fixes a bug where parameter and return value documentation wasn't hidden from language representations of a symbol without a function signature (for example properties).
With these changes, if one of the symbol's language representation has a function signature, all property and return value documentation will be hidden from its language representations that don't have function signatures.
Dependencies
None
Testing
In a mixed Swift and Objective-C project, add a symbol that's a function in C but refines to a property in Swift. For example
Build documentation for the project and view the
isEmptySwift property documentation.Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/testscript and it succeeded[ ] Updated documentation if necessaryNot applicable.